Extend documentation for integration tests #337
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matamegger
reviewed
Nov 29, 2023
| export const callPlayer = async <T>( | ||
| fn: (player: Player) => Promise<T> | ||
| ): Promise<T> => { | ||
| return await PlayerWorld.shared.callPlayer(fn); | ||
| }; | ||
|
|
||
| /** | ||
| * Calls the given function with the player instance and expects the given event to occur. |
There was a problem hiding this comment.
? which given function
Listens for the specified
Eventto be emitted and waits until the event is received
There was a problem hiding this comment.
oopsie, fixed in a416968
…r-testing/add-more-documentation
matamegger
approved these changes
Nov 30, 2023
Base automatically changed from
player-testing/add-player-testing-framework
to
development
December 13, 2023 07:39
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There is not much documentation about player testing in the repo right now.
Changes
integration_test/README.mdCONTRIBUTING.mdwith instructions for adding new testsChecklist
CHANGELOGentry